home *** CD-ROM | disk | FTP | other *** search
/ Palm Utilities / Palm_Utilities_CD-ROM_2001_2001.iso / files / utils sync / JetSync 1.0 / jetsync-1.0.exe / jetsync-1.0 / README < prev    next >
Encoding:
Text File  |  1999-10-27  |  5.3 KB  |  130 lines
  1. JetSync v1.0
  2. ============
  3.  
  4.     JetSync v1.0 - PDA PalmPilot synchronization with Linux
  5.     Copyright (C) 1999 Miguel Frias, Joaquim Agostinho
  6.  
  7.     This program is free software; you can redistribute it and/or
  8.     modify it under the terms of the GNU Lesser General Public
  9.     License as published by the Free Software Foundation; either
  10.     version 2 of the License, or (at your option) any later version.
  11.  
  12.     Redistribution is allowed, but the authors would like to be informed
  13.     about it. Modification is only allowed if it is for PRIVATE use.
  14.  
  15.     This program is distributed in the hope that it will be useful,
  16.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18.     Lesser General Public License for more details. A copy of the license
  19.     is provided in this distribution under the file named "COPYING".
  20.  
  21.     Miguel Frias, frias@rnl.ist.utl.pt
  22.     Joaquim Agostinho, joaquim.agostinho@anaep.pt
  23.  
  24.  
  25. Contents
  26. ========
  27.  
  28. This distribution contains:
  29.  
  30. *) JetSync - synchronization desktop application
  31. *) JetMemo, JetAddr and JetToDo - applications under Linux to handle
  32.    memos addresses and todos.
  33. *) default conduits for Memo, Addresses, ToDo, Datebook and Mail
  34. *) special conduit Install, to install files on the PalmPilot
  35. *) library 'libjetsync' - API for PalmPilot communication
  36.  
  37.  
  38. Instructions on how to compile and install JetSync v1.0
  39. =======================================================
  40.  
  41. You are unadvised to run 'make' manually.
  42. Instead, use the setup program available in this distribution.
  43.  
  44. Type ./setup
  45.  
  46. Setup does not require you to be superuser. JetSync can be installed in
  47. a user's home directory, fully functional. You are advised to install JetSync
  48. under your home directory ($HOME/.jetsync).
  49.  
  50. NOTE: if you have already installed a previous version of JetSync click
  51. "Install binaries only" instead of "Install all" when prompted; otherwise,
  52. your previous data will be overwritten.
  53.  
  54. After installation has ended you should not remove the distribution package
  55. since future conduit installation requires the whole jetsync system to be
  56. recompiled.
  57. If you are sure you don't want any other conduits installed, then you are
  58. free to remove this directory tree.
  59.  
  60.  
  61. Testing
  62. =======
  63.  
  64. JetSync was tested on PalmPilots versions III, IIIx and Vx. Development took
  65. place on a PentiumPro 300MHz running Linux 2.0.35 with Slackware and KDE.
  66.  
  67. Please note that JetSync was designed with a minimum library request. This means
  68. the only things you NEED to have installed is: Tcl/Tk and pilot-link.
  69.  
  70. Datebook synchronization uses iCal files; therefore, you must have it installed
  71. if you wish to use the Datebook conduit.
  72.  
  73. JetSync was only tested with Tcl/Tk version >= 7.6. You are advised to have
  74. Tcl/Tk version >= 8.0 since 7.6 does not have one or two features. Those
  75. features should not keep JetSync from working, though.
  76. Tcl/Tk is available in many development sites and is quite easy to find. You
  77. can download the newest version from:
  78. http://www.scriptics.com/products/tcltk/
  79.  
  80. pilot-link is the structure JetSync is built upon. JetSync was tested under
  81. version 0.9.x of this distribution. You can download it from:
  82. ftp://ryeham.ee.ryerson.ca/pub/PalmOS/
  83.  
  84. Information on pilot-link:
  85. http://www.cs.purdue.edu/homes/zamboni/Pilot/unix-settingup.html
  86.  
  87.  
  88. Documentation
  89. =============
  90.  
  91. There is currently only a portuguese version of the documentation files.
  92. Therefore, this is a brief note on how to do things:
  93.  
  94. 1) If you wish to build a new conduit to be used in jetsync, see how the other
  95.    conduits were designed in the directory src/Conduits. Conduits that are
  96.    meant to be used with record-id based data types should be very easy to
  97.    build. You can use both 'makeconduit' (to generate the conduit based on a
  98.    skeleton) and 'addconduit' (to add the conduit to the jetsync system.
  99.    These tools are available in the src/Conduits directory. After the conduit
  100.    compiles successfully you must run ./setup again in order to include the
  101.    new conduits object code.
  102.    When prompted for an installation DO NOT choose the 'Install' button.
  103.    Instead, click "Install binaries only". Otherwise, your user configs and
  104.    data will be overwritten.
  105.  
  106. 2) The src/libjetsync directory contains an API for PalmPilot connections.
  107.     js_InitComm  - opens the connection to the pilot
  108.      js_Connect  - retrieves a list of all databases in pilot
  109.        js_Synch  - manages all the synchronization in the pilot calling all
  110.                    conduits that are installed
  111.    js_CloseComm  - closes the connection to the pilot
  112.       js_Upload  - uploads a file to the pilot
  113.     js_Download  - downloads a file from the pilot
  114.    js_ChangeUser - changes the pilot's username
  115.  
  116. 3) The 3 basic applications used in JetSync are jetmemo, jetaddr and jettodo.
  117.    These were developed under both Tcl/Tk and C. They should not be changed
  118.    since data could become corrupted.
  119.  
  120. 4) Another application button is provided (iCal/Datebook). The datebook conduit
  121.    uses the data format of iCal. If you which to use iCal:
  122.  
  123.    *) information on the current version can be found at:
  124.  http://www.research.digital.com/SRC/personal/Sanjay_Ghemawat/ical/home.html
  125.  
  126.  
  127. If you wish the full documentation files, these can be sent to you by email
  128. in Word 97 format (user manual=160Kb + programmer's manual=12Mb). The docs
  129. are written entirely in portuguese.
  130.